Skip to content

Use markdown lang in the readme. #1836

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Feb 5, 2014
Merged

Use markdown lang in the readme. #1836

merged 3 commits into from
Feb 5, 2014

Conversation

KonradIT
Copy link
Contributor

Markdown language allow users in GH a rich and powerful text processor.
Rename readme.txt to readme.mkdn
I also included a title, some bullet points and subtitles like installation and credits.

@matthijskooijman
Copy link
Collaborator

Changes look good. Result can be viewed here: https://github.com/KonradIT/Arduino/blob/master/README.mkdn

Two remarks though:

  • It seems more common to use "README.md" instead of "README.mkdn", perhaps you could use that?
  • These two commits really are one logical change, so they should be squashed together.

If you agree and want to change those things, please make the changes and do a force push to update this pullrequest (e.g., don't open a new pullrequest just for this).

@KonradIT
Copy link
Contributor Author

I have pushed readme.md ! :octocat:

@matthijskooijman
Copy link
Collaborator

Cool!
Could you also squash together all commits? If you haven't done this before - interactive rebase is probably the best (short-short-version: run git rebase -i origin/master and in the editor you get, replace the pick for the last two commits with fixup or just f). You might want to read up on (interactive) rebase, since it is totally awesome! :-)

cmaglie added a commit that referenced this pull request Feb 5, 2014
Use markdown lang in the readme.
@cmaglie cmaglie merged commit b415903 into arduino:master Feb 5, 2014
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants